Спринт 3/18 → Тема 2/3: Финальный проект спринта: модуль фитнес-трекера → Урок 1/5
Как отправлять финальное задание спринта на ревью
Ура! Вы добрались до финального проекта спринта. Это ваш первый проект, который вы отправите на проверку через Git. Прежде чем приступить к выполнению задачи, изучите технические подробности.
При работе над финальным заданием вас ожидает три обязательных этапа:
- Получить и развернуть проект с заданием
- Выполнить задание и протестировать его
- Отправить задание на проверку
Где взять задание?
- Привяжите свой аккаунт GitHub к аккаунту Яндекс Практикума: для этого в верхней части страницы урока с финальным заданием есть специальная кнопка.После связывания аккаунтов эта кнопка изменится: теперь она будет служить для отправки задания на проверку.
- Когда аккаунты будут связаны — в вашем аккаунте на GitHub появится приватный репозиторий hw_python_oop.
- Клонируйте этот репозиторий на свой компьютер:
git clone .... В репозитории hw_python_oop лежит файл для домашнего задания homework.py, набор автоматических тестов и некоторое количество служебных директорий и файлов. - В директории /hw_python_oop установите и активируйте виртуальное окружение. Папка проекта должна принять такой вид:
- Запустите виртуальное окружение и через менеджер пакетов pip установите программу автоматического тестирования кода
pytest.BASH - Установите линтер flake8:BASH
Теперь всё готово, можно выполнять домашнее задание!
Проверка и работа над ошибками
После того, как задание выполнено — проверьте свою работу на соответствие правилам оформления кода и на отсутствие ошибок.
- Для каждого файла, с которым вы работали, запустите flake8: он проверит ваш код на соответствие стандартам оформления:BASH
- Запустите
pytest— и автоматические тесты, написанные для задания, проверят, правильно ли работает ваш код; убедитесь, что тесты проходят успешно. Как установитьpytestи запустить тесты — описано в инструкции.
Если линтер или тесты обнаружат ошибку — исправьте код и вновь выполните обе проверки.
Отправка задания на платформу
Выполненную и проверенную работу нужно отправить на платформу. Там будет проведена повторная проверка линтером и тестами (уже без вашего участия, автоматически), а затем ваше задание проверит специалист-ревьюер.
- Первым делом нужно отправить код в удалённый репозиторий на GitHub.Перед отправкой проверьте содержимое файла .gitignore: в репозиторий не должны отправляться файлы и директории, не относящиеся к выполненной работе. Вот названия файлов, которые обычно в нём указываются:В вашем проекте необязательно должны быть все файлы из списка. Укажите только те, которые есть в текущей структуре проекта.Далее выполните команды:
git add .— добавить файлы в индекс отслеживания Git;git commit -m 'текст комментария'— создать коммит (он будет создан локально), зафиксировать изменения;git push— запушить коммит на удалённый сервер.
- Нажмите кнопку «Проверить задание» вверху страницы с заданием. Ваш код отправится на код-ревью, его проверят автотесты, а затем — ревьюеры.
❗ Будьте внимательны: файлы и директории вашего проекта должны быть размещены в головной папке репозитория, который вы скачали.
Если проект не удаётся отправить обычным способом и платформа предлагает загрузить проект архивом — ваш архив должен соответствовать правилам:
- быть строго в формате ZIP;
- размер архива должен быть меньше 4 MB.
Чтобы получить архив с проектом в нужном формате, скачайте его с GitHub:
Если возникнут проблемы в работе с Git — поищите подсказки в уроках темы «Настройка окружения: Git, pytest», обратитесь к одногруппникам или наставнику.